Dav accessible

Represents a Data Series, and provides properties for ranking participants etc

Properties

Name Returns Notes Example
leaderboard DataSeriesLeaderBoard Dav accessible Get the default leaderboard which does not apply any date range restrictions, ie is for all time
children List
allKpis ResourceList
availableKpis ResourceList Returnsall KPIs in this data series which are available to the current user
extraFieldNames List
extraFields List
myRecords List Returns all records for the current user in this series
history List
parent CommonCollectionResource
name String
title String
categoryName String
units String
period String

Methods

Name Returns Notes Example
getLeaderboard ( start, finish ) DataSeriesLeaderBoard Create a new instance of a leaderboard for the given dates
availableKpis ( p ) ResourceList
getKpiByName ( name ) KpiDataPage
recordsForProfile ( p ) List Locate all records in this series for a particular user (ProfileBean)

REST Operations

- do a GET with leaderboard=highest or leaderboard=lowest to get the leaderboard as JSON. Other parameters: startDate, endDate as unix timestamps, limit=max results to retrieve
Hide comments

Ask a question, or offer an answer